jekyll-spaceship 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6ae47db0fb8b3515463a5703cdbfa2c596262066b0af602e3d7f82360872c78
-  data.tar.gz: 9f4c96c07fe26d5b1e9a44338375a29470d528e2375902d9e7198cfe377d0b26
+  metadata.gz: 989c96c9ba4f7b3d1ec891d43022360ab1bea0a4de2956e8a94c24c927df6ca1
+  data.tar.gz: 3aa37c0d529d883e2cef637556d65f65d31e9a5c8ee304ca2a2ee01de11ac527
 SHA512:
-  metadata.gz: 7a24363b63096f27c60c92aa0ad37561cf230ae6e61c0e49b7c556e9a584c1ffddc388cf3ab3cb424382351d55a30439628f6a909e93aae4cfce51363f8ffd0f
-  data.tar.gz: 297d038c14a9bdb8b856b414eaefba93232ff82518a3c01eaf97ac98f2dd1792d6d875a140e5f30497dbcb759f4e59a6ea6632c64c186f0acacfb249152b2c3e
+  metadata.gz: a7bbab4048b639e86cf01e88132c4b9de13acf9651667bcefc15eaaae6c57a3663b69498ebf6172037268ecb63a456a8cf53c751036717f471a8e060a7b5a14b
+  data.tar.gz: 56aab57a999fd3604f1b95475662478c8520ab703a9ae2405f863072c92c012cb1dec094814d17d6e1696ce2d3eea7fb0987e78a77a6c7a8465b95db61826702

data/README.md

@@ -107,11 +107,14 @@ Spaceship is a minimalistic, powerful and extremely customizable [Jekyll](https:
     - [2.2 How to use?](#22-how-to-use)
   - [3. PlantUML Usage](#3-plantuml-usage)
   - [4. Mermaid Usage](#4-mermaid-usage)
-  - [5. Video Usage](#5-video-usage)
+  - [5. Media Usage](#5-media-usage)
     - [5.1 Youtube Usage](#youtube-usage)
     - [5.2 Vimeo Usage](#vimeo-usage)
     - [5.3 DailyMotion Usage](#dailymotion-usage)
-    - [5.4 General Video Usage](#general-video-usage)
+    - [5.4 Spotify Usage](#spotify-usage)
+    - [5.5 SoundCloud Usage](#soundcloud-usage)
+    - [5.6 General Video Usage](#general-video-usage)
+    - [5.7 General Audio Usage](#general-audio-usage)
   - [6. Hybrid HTML with Markdown](#6-hybrid-html-with-markdown)
   - [7. Markdown Polyfill](#7-markdown-polyfill)
     - [7.1 Escape Ordered List](#71-escape-ordered-list)
@@ -162,7 +165,7 @@ jekyll-spaceship:
     - plantuml-processor
     - mermaid-processor
     - polyfill-processor
-    - video-processor
+    - media-processor
     - emoji-processor
     - element-processor
   mathjax-processor:
@@ -194,14 +197,14 @@ jekyll-spaceship:
     config:
       theme: default
     src: https://mermaid.ink/svg/
-  video-processor:
+  media-processor:
     default:
-      id: 'video-{id}'
-      class: 'video'
+      id: 'media-{id}'
+      class: 'media'
       width: '100%'
       height: 350
-      border: 0
-      style: 'max-width: 600px'
+      frameborder: 0
+      style: 'max-width: 600px; outline: none;'
       allow: 'encrypted-media; picture-in-picture'
   emoji-processor:
     css:
@@ -705,25 +708,31 @@ Code above would be parsed as:
 
 ![Mermaid Diagram](https://user-images.githubusercontent.com/9413601/85282355-2e317300-b4be-11ea-9c30-8f9d61540d14.png)
 
-### 5. Video Usage
+### 5. Media Usage
 
-How often did you find yourself googling "**How to embed a video in markdown?**"
+How often did you find yourself googling "**How to embed a video/audio in markdown?**"
 
-While its not possible to embed a video in markdown, the best and easiest way is to extract a frame from the video. To add videos to your markdown files easier I developped this tool for you, and it will parse the video link inside the image block automatically.
+While its not possible to embed a video/audio in markdown, the best and easiest
+way is to extract a frame from the video/audio. To add videos/audios to your
+markdown files easier I developped this tool for you, and it will parse the
+video/audio link inside the image block automatically.
 
-**For now, these video links parsing are provided:**
+**For now, these media links parsing are provided:**
 
 - Youtube
 - Vimeo
 - DailyMotion
-- General Video ( mp4 | avi | webm | ogg | ogv | 3gp | flv | mov ... )
+- Spotify
+- SoundCloud
+- General Video ( mp4 | avi | ogg | ogv | webm | 3gp | flv | mov ... )
+- General Audio ( mp3 | wav | ogg | mid | midi | aac | wma ... )
 
-There are two ways to embed a video in your Jekyll blog page:
+There are two ways to embed a video/audio in your Jekyll blog page:
 
 Inline-style:
 
 ```markdown
-![]({video-link})
+![]({media-link})
 ```
 
 Reference-style:
@@ -731,10 +740,10 @@ Reference-style:
 ```markdown
 ![][{reference}]
 
-[{reference}]: {video-link}
+[{reference}]: {media-link}
 ```
 
-For configuring video attributes (e.g, width, height), just adding query string to
+For configuring media attributes (e.g, width, height), just adding query string to
 the link as below:
 
 ```markdown
@@ -767,6 +776,22 @@ the link as below:
 ![](https://dai.ly/x7tgcev?width=100%&height=400)
 ```
 
+#### Spotify Usage
+
+```markdown
+![](http://open.spotify.com/track/4Dg5moVCTqxAb7Wr8Dq2T5)
+```
+
+<image width="600" src="https://user-images.githubusercontent.com/9413601/89762618-5d11b000-db23-11ea-81db-35cc3682b234.png">
+
+#### SoundCloud Usage
+
+```markdown
+![](https://soundcloud.com/aviciiofficial/preview-avicii-vs-lenny)
+```
+
+<image width="600" src="https://user-images.githubusercontent.com/9413601/89762969-1c666680-db24-11ea-97e3-4340f7fac7ac.png">
+
 #### General Video Usage
 
 ```markdown
@@ -777,6 +802,15 @@ the link as below:
 ![](//techslides.com/demos/sample-videos/small.mp4?width=400)
 ```
 
+#### General Audio Usage
+
+```markdown
+![](//www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3)
+
+![](//www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3?autoplay=1&loop=1)
+```
+
+<image width="300" src="https://user-images.githubusercontent.com/9413601/89762143-68181080-db22-11ea-8467-e8b2a8a96ae5.png">
 
 ### 6. Hybrid HTML with Markdown
 
@@ -950,7 +984,7 @@ jekyll-spaceship:
     css:
       - a:                                     # Replce all `a` tags
           props:                               #
-            loading: lazy                      # Replace `lading` value to `lazy`
+            loading: lazy                      # Replace `loading` value to `lazy`
 ```
 
 In case you want to prevent loading some images/iframes lazily, add

data/jekyll-spaceship.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = Jekyll::Spaceship::VERSION
   spec.authors       = ["jeffreytse"]
   spec.email         = ["jeffreytse.mail@gmail.com"]
-  spec.summary       = "A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, mermaid, emoji, video, youtube, vimeo, dailymotion, etc."
+  spec.summary       = "A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, mermaid, emoji, video, audio, youtube, vimeo, dailymotion, spotify, soundcloud, etc."
   spec.homepage      = "https://github.com/jeffreytse/jekyll-spaceship"
   spec.license       = "MIT"
 

data/lib/jekyll-spaceship/cores/config.rb

@@ -10,7 +10,7 @@ module Jekyll::Spaceship
         'plantuml-processor',
         'mermaid-processor',
         'polyfill-processor',
-        'video-processor',
+        'media-processor',
         'emoji-processor',
         'element-processor'
       ]

data/lib/jekyll-spaceship/processors/media-processor.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Jekyll::Spaceship
+  class MediaProcessor < Processor
+    def self.config
+      {
+        'default' => {
+          'id' => 'media-{id}',
+          'class' => 'media',
+          'width' => '100%',
+          'height' => 350,
+          'frameborder' => 0,
+          'style' => 'max-width: 600px;outline: none',
+          'allow' => 'encrypted-media; picture-in-picture'
+        }
+      }
+    end
+
+    def on_handle_markdown(content)
+      content = handle_normal_audio(content)
+      content = handle_normal_video(content)
+      content = handle_youtube(content)
+      content = handle_vimeo(content)
+      content = handle_dailymotion(content)
+      content = handle_spotify(content)
+      content = handle_soundcloud(content)
+    end
+
+    # Examples:
+    # ![audio](//www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3)
+    # ![audio](//www.expample.com/examples/t-rex-roar.mp3?autoplay=true&loop=true)
+    def handle_normal_audio(content)
+      handle_media(content, {
+        media_type: 'audio',
+        host: '(https?:)?\\/\\/.*\\/',
+        id: '(.+?\\.(mp3|wav|ogg|mid|midi|aac|wma))',
+      })
+    end
+
+
+    # Examples:
+    # ![video](//www.html5rocks.com/en/tutorials/video/basics/devstories.webm)
+    # ![video](//techslides.com/demos/sample-videos/small.ogv?allow=autoplay)
+    # ![video](//techslides.com/demos/sample-videos/small.mp4?width=400)
+    def handle_normal_video(content)
+      handle_media(content, {
+        media_type: 'iframe',
+        host: '(https?:)?\\/\\/.*\\/',
+        id: '(.+?\\.(avi|mp4|webm|ogg|ogv|flv|mkv|mov|wmv|3gp|rmvb|asf))'
+      })
+    end
+
+    # Examples:
+    # ![youtube](https://www.youtube.com/watch?v=XA2WjJbmmoM "title")
+    # ![youtube](http://www.youtube.com/embed/w-m_yZCLF5Q)
+    # ![youtube](//youtu.be/mEP3YXaSww8?height=100%&width=400)
+    def handle_youtube(content)
+      handle_media(content, {
+        media_type: 'iframe',
+        host: '(https?:)?\\/\\/.*youtu.*',
+        id: '(?<=\\?v\\=|embed\\/|\\.be\\/)([a-zA-Z0-9\\_\\-]+)',
+        base_url: "https://www.youtube.com/embed/"
+      })
+    end
+
+    # Examples:
+    # ![vimeo](https://vimeo.com/263856289)
+    # ![vimeo](https://vimeo.com/263856289?height=100%&width=400)
+    def handle_vimeo(content)
+      handle_media(content, {
+        media_type: 'iframe',
+        host: '(https?:)?\\/\\/vimeo\\.com\\/',
+        id: '([0-9]+)',
+        base_url: "https://player.vimeo.com/video/"
+      })
+    end
+
+    # Examples:
+    # ![dailymotion](https://www.dailymotion.com/video/x7tgcev)
+    # ![dailymotion](https://dai.ly/x7tgcev?height=100%&width=400)
+    def handle_dailymotion(content)
+      handle_media(content, {
+        media_type: 'iframe',
+        host: '(https?:)?\\/\\/.*dai.?ly.*',
+        id: '(?<=video\\/|\\/)([a-zA-Z0-9\\_\\-]+)',
+        base_url: "https://www.dailymotion.com/embed/video/"
+      })
+    end
+
+    # Examples:
+    # ![spotify](//open.spotify.com/track/4Dg5moVCTqxAb7Wr8Dq2T5)
+    # ![spotify](//open.spotify.com/track/37mEkAaqCE7FXMvnlVA8pp?width=400)
+    def handle_spotify(content)
+      handle_media(content, {
+        media_type: 'iframe',
+        host: '(https?:)?\\/\\/open\\.spotify\\.com\\/track\\/',
+        id: '(?<=track\\/)([a-zA-Z0-9\\_\\-]+)',
+        base_url: "https://open.spotify.com/embed/track/",
+        height: 80
+      })
+    end
+
+    # Examples:
+    # ![soundcloud](//soundcloud.com/aviciiofficial/preview-avicii-vs-lenny)
+    def handle_soundcloud(content)
+      handle_media(content, {
+        media_type: 'iframe',
+        id_from: 'html',
+        host: '(https?:)?\\/\\/soundcloud\\.com\\/.+\\/[^\\?]+',
+        id: '(?<=soundcloud:\\/\\/sounds:)([0-9]+)',
+        base_url: "https://w.soundcloud.com/player/?url="\
+          "https%3A//api.soundcloud.com/tracks/",
+        height: 125,
+      })
+    end
+
+    def handle_media(content, data)
+      host = data[:host]
+      return content if content.sub(/#{host}/, '').nil?
+
+      media_type = data[:media_type]
+      base_url = data[:base_url]
+      id = data[:id_from] === 'html' ? '()' : data[:id]
+      url = "(#{host}#{id}\\S*)"
+      title = '("(.*)".*){0,1}'
+
+      # pre-handle reference-style links
+      regex = /(\[(.*)\]:\s*(#{url}\s*#{title}))/
+      content.scan regex do |match_data|
+        match = match_data[0]
+        ref_name = match_data[1]
+        ref_value = match_data[2]
+        content = content.gsub(match, '')
+          .gsub(/\!\[(.*)\]\s*\[#{ref_name}\]/,
+            "![\1](#{ref_value})")
+      end
+
+      # handle inline-style links
+      regex = /(\!\[(.*)\]\(.*#{url}\s*#{title}\))/
+      content.scan regex do |match_data|
+        url = match_data[2]
+        id = data[:id_from] === 'html' \
+          ? get_id_from_html(url, data[:id]) \
+          : match_data[4]
+        title = match_data[6]
+        qs = url.match(/(?<=\?)(\S*?)$/)
+        qs = Hash[URI.decode_www_form(qs.to_s)].reject do |k, v|
+          next true if v == id or v == ''
+        end
+
+        cfg = self.config['default'].clone
+        cfg['id'] = qs['id'] || cfg['id']
+        cfg['class'] = qs['class'] || cfg['class']
+        cfg['style'] = qs['style'] || cfg['style']
+        cfg['id'] = cfg['id'].gsub('{id}', id)
+        cfg['class'] = cfg['class'].gsub('{id}', id)
+
+        cfg['src'] = URI(base_url ? "#{base_url}#{id}" : url).tap do |v|
+          v.query = URI.encode_www_form(qs) if qs.size > 0
+        end
+
+        case media_type
+        when 'audio'
+          cfg['autoplay'] = qs['autoplay'] || data[:autoplay] || cfg['autoplay']
+          cfg['loop'] = qs['loop'] || data[:loop] || cfg['loop']
+          cfg['style'] += ';display: none;' if qs['hidden']
+          content = handle_audio(content, { target: match_data[0], cfg: cfg })
+        when 'iframe'
+          cfg['title'] = title
+          cfg['width'] = qs['width'] || data[:width] || cfg['width']
+          cfg['height'] = qs['height'] || data[:height] || cfg['height']
+          cfg['frameborder'] = qs['frameborder'] || cfg['frameborder']
+          cfg['allow'] ||= cfg['allow']
+          content = handle_iframe(content, { target: match_data[0], cfg: cfg })
+        end
+        self.handled = true
+      end
+      content
+    end
+
+    def handle_audio(content, data)
+      cfg = data[:cfg]
+      html = "<audio"\
+        " id=\"#{cfg['id']}\""\
+        " class=\"#{cfg['class']}\""\
+        " #{cfg['autoplay'] ? 'autoplay' : ''}"\
+        " #{cfg['loop'] ? 'loop' : ''}"\
+        " src=\"#{cfg['src']}\""\
+        " style=\"#{cfg['style']}\""\
+        " controls>" \
+        "<p> Your browser doesn't support HTML5 audio."\
+        " Here is a <a href=\"#{cfg['src']}\">link to download the audio</a>"\
+        "instead. </p>"\
+        "</audio>"
+      content.gsub(data[:target], html)
+    end
+
+    def handle_iframe(content, data)
+      cfg = data[:cfg]
+      html = "<iframe"\
+        " id=\"#{cfg['id']}\""\
+        " class=\"#{cfg['class']}\""\
+        " src=\"#{cfg['src']}\""\
+        " title=\"#{cfg['title']}\""\
+        " width=\"#{cfg['width']}\""\
+        " height=\"#{cfg['height']}\""\
+        " style=\"#{cfg['style']}\""\
+        " allow=\"#{cfg['allow']}\""\
+        " frameborder=\"#{cfg['frameborder']}\""\
+        " allowfullscreen>"\
+        "</iframe>"
+      content.gsub(data[:target], html)
+    end
+
+    def get_id_from_html(url, pattern)
+      id = ''
+      begin
+        url = 'https:' + url if url.start_with? '//'
+        res = Net::HTTP.get_response URI(url)
+        raise res.body unless res.is_a?(Net::HTTPSuccess)
+        res.body.match pattern do |match_data|
+          id = match_data[0]
+          break
+        end
+      rescue StandardError => msg
+        data = url
+        logger.log msg
+      end
+      id
+    end
+  end
+end

data/lib/jekyll-spaceship/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Spaceship
-    VERSION = "0.9.0"
+    VERSION = "0.9.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-01 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -140,11 +140,11 @@ files:
 - lib/jekyll-spaceship/processors/element-processor.rb
 - lib/jekyll-spaceship/processors/emoji-processor.rb
 - lib/jekyll-spaceship/processors/mathjax-processor.rb
+- lib/jekyll-spaceship/processors/media-processor.rb
 - lib/jekyll-spaceship/processors/mermaid-processor.rb
 - lib/jekyll-spaceship/processors/plantuml-processor.rb
 - lib/jekyll-spaceship/processors/polyfill-processor.rb
 - lib/jekyll-spaceship/processors/table-processor.rb
-- lib/jekyll-spaceship/processors/video-processor.rb
 - lib/jekyll-spaceship/utils/.keep
 - lib/jekyll-spaceship/version.rb
 - logos/jekyll-spaceship-logo.png
@@ -173,5 +173,6 @@ rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to provide powerful supports for table, mathjax, plantuml,
-  mermaid, emoji, video, youtube, vimeo, dailymotion, etc.
+  mermaid, emoji, video, audio, youtube, vimeo, dailymotion, spotify, soundcloud,
+  etc.
 test_files: []

data/lib/jekyll-spaceship/processors/video-processor.rb

@@ -1,139 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-
-module Jekyll::Spaceship
-  class VideoProcessor < Processor
-    def self.config
-      {
-        'default' => {
-          'id' => 'video-{id}',
-          'class' => 'video',
-          'width' => '100%',
-          'height' => 350,
-          'border' => 0,
-          'style' => 'max-width: 600px',
-          'allow' => 'encrypted-media; picture-in-picture',
-        }
-      }
-    end
-
-    def on_handle_markdown(content)
-      content = handle_normal_video(content)
-      content = handle_youtube(content)
-      content = handle_vimeo(content)
-      content = handle_dailymotion(content)
-    end
-
-    # Examples:
-    # ![video](//www.html5rocks.com/en/tutorials/video/basics/devstories.webm)
-    # ![video](//techslides.com/demos/sample-videos/small.ogv?allow=autoplay)
-    # ![video](//techslides.com/demos/sample-videos/small.mp4?width=400)
-    def handle_normal_video(content)
-      handle_video(content, {
-        host: '(https?:)?\\/\\/.*\\/',
-        id: '(.+?\\.(avi|mp4|webm|ogg|ogv|flv|mkv|mov|wmv|3gp|rmvb|asf))',
-      })
-    end
-
-    # Examples:
-    # ![youtube](https://www.youtube.com/watch?v=XA2WjJbmmoM "title")
-    # ![youtube](http://www.youtube.com/embed/w-m_yZCLF5Q)
-    # ![youtube](//youtu.be/mEP3YXaSww8?height=100%&width=400)
-    def handle_youtube(content)
-      handle_video(content, {
-        host: '(https?:)?\\/\\/.*youtu.*',
-        id: '(?<=\\?v\\=|embed\\/|\\.be\\/)([a-zA-Z0-9\\_\\-]+)',
-        iframe_url: "https://www.youtube.com/embed/"
-      })
-    end
-
-    # Examples:
-    # ![vimeo](https://vimeo.com/263856289)
-    # ![vimeo](https://vimeo.com/263856289?height=100%&width=400)
-    def handle_vimeo(content)
-      handle_video(content, {
-        host: '(https?:)?\\/\\/vimeo\\.com\\/',
-        id: '([0-9]+)',
-        iframe_url: "https://player.vimeo.com/video/"
-      })
-    end
-
-    # Examples:
-    # ![dailymotion](https://www.dailymotion.com/video/x7tgcev)
-    # ![dailymotion](https://dai.ly/x7tgcev?height=100%&width=400)
-    def handle_dailymotion(content)
-      handle_video(content, {
-        host: '(https?:)?\\/\\/.*dai.?ly.*',
-        id: '(?<=video\\/|\\/)([a-zA-Z0-9\\_\\-]+)',
-        iframe_url: "https://www.dailymotion.com/embed/video/"
-      })
-    end
-
-    def handle_video(content, data)
-      host = data[:host]
-      return content if content.sub(/#{host}/, '').nil?
-
-      iframe_url = data[:iframe_url]
-      id = data[:id]
-      url = "(#{host}#{id}\\S*)"
-      title = '("(.*)".*){0,1}'
-
-      # pre-handle reference-style links
-      regex = /(\[(.*)\]:\s*(#{url}\s*#{title}))/
-      content.scan regex do |match_data|
-        match = match_data[0]
-        ref_name = match_data[1]
-        ref_value = match_data[2]
-        content = content.gsub(match, '')
-          .gsub(/\!\[(.*)\]\s*\[#{ref_name}\]/,
-            "![\1](#{ref_value})")
-      end
-
-      # handle inline-style links
-      regex = /(\!\[(.*)\]\(.*#{url}\s*#{title}\))/
-      content.scan regex do |match_data|
-        url = match_data[2]
-        id = match_data[4]
-        title = match_data[6]
-        qs = url.match(/(?<=\?)(\S*?)$/)
-        qs = Hash[URI.decode_www_form(qs.to_s)].reject do |k, v|
-          next true if v == id or v == ''
-        end
-
-        default = self.config['default']
-        css_id = qs['id'] || default['id']
-        css_class = qs['class'] || default['class']
-        width = qs['width'] || data[:width] || default['width']
-        height = qs['height'] || data[:height] || default['height']
-        frameborder = qs['frameborder'] || default['border']
-        style = qs['style'] || default['style']
-        allow = qs['allow'] || default['allow']
-
-        css_id = css_id.gsub('{id}', id)
-        css_class = css_class.gsub('{id}', id)
-
-        url = URI(iframe_url ? "#{iframe_url}#{id}" : url).tap do |v|
-          v.query = URI.encode_www_form(qs) if qs.size > 0
-        end
-
-        html = "<iframe"\
-          " id=\"#{css_id}\""\
-          " class=\"#{css_class}\""\
-          " src=\"#{url}\""\
-          " title=\"#{title}\""\
-          " width=\"#{width}\""\
-          " height=\"#{height}\""\
-          " style=\"#{style}\""\
-          " allow=\"#{allow}\""\
-          " frameborder=\"#{frameborder}\""\
-          " allowfullscreen>" \
-          "</iframe>"
-
-        content = content.gsub(match_data[0], html)
-        self.handled = true
-      end
-      content
-    end
-  end
-end